Skip to content

feat(sdk): add stashId to runAction #17020

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jun 6, 2025
Merged

feat(sdk): add stashId to runAction #17020

merged 3 commits into from
Jun 6, 2025
+27 −5

Conversation

@js07
Copy link
Collaborator

@js07 js07 commented Jun 6, 2025 •
edited by coderabbitai bot
Loading

WHY

The API's POST /actions/run endpoint now accepts a stash_id parameter and returns a stashId in the response body. This enables files to be persisted between action runs.

Summary by CodeRabbit

  • New Features
    • Added support for a new option to enable file persistence between action runs for up to one day.
  • Documentation
    • Updated changelog to reflect the new feature and version bump.
  • Chores
    • Incremented the SDK version to 1.6.7.

@vercel
Copy link

vercel bot commented Jun 6, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Jun 6, 2025 5:02pm
pipedream-docs ⬜️ Ignored (Inspect) Jun 6, 2025 5:02pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jun 6, 2025 5:02pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 6, 2025 •
edited
Loading

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce a new optional stashId property to the RunActionOpts and RunActionResponse types, enabling file persistence between action runs by synchronizing the /tmp directory via a File Stash. The runAction method is updated to support this option. Documentation and versioning are updated accordingly.

Changes

File(s) Change Summary
packages/sdk/src/shared/index.ts Added stashId to RunActionOpts and RunActionResponse; updated runAction to handle stashId.
packages/sdk/CHANGELOG.md Added changelog entry for version 1.6.7 documenting the new stashId option for runAction.
packages/sdk/package.json Bumped version from 1.6.6 to 1.6.7.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SDK (BaseClient)
    participant API

    User->>SDK (BaseClient): runAction({ ..., stashId })
    SDK (BaseClient)->>API: POST /runAction { ..., stash_id: stashId }
    API-->>SDK (BaseClient): { ..., stashId }
    SDK (BaseClient)-->>User: RunActionResponse (includes stashId if used)
Loading

Poem

A stash for your files, a hop and a dash,
Actions now linger, not gone in a flash!
With stashId in tow, your temp files stay near,
Persisting through runs, the intent is clear.
Version bumped up, the changelog in sight—
Rabbits rejoice, for persistence feels right!
🐇✨

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@js07 js07 changed the title feat(sdk): add stashId to runAction feat(sdk): add stashId to runAction Jun 6, 2025
@js07 js07 marked this pull request as ready for review June 6, 2025 02:29
@dannyroosevelt dannyroosevelt merged commit ceea1c8 into master Jun 6, 2025
10 checks passed
@dannyroosevelt dannyroosevelt deleted the feat/run-action-stash-id branch June 6, 2025 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jsendo jsendo jsendo approved these changes

@dannyroosevelt dannyroosevelt dannyroosevelt approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@js07 @jsendo @dannyroosevelt